<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>TagM: RTOS::clock Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">TagM
   &#160;<span id="projectnumber">1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="class_r_t_o_s.html">RTOS</a></li><li class="navelem"><a class="el" href="class_r_t_o_s_1_1clock.html">clock</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">RTOS::clock Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>free-running clock, ticks at a fixed frequency  
 <a href="class_r_t_o_s_1_1clock.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="p_r_t_o_s_8h_source.html">pRTOS.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RTOS::clock:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_r_t_o_s_1_1clock.png" usemap="#RTOS::clock_map" alt=""/>
  <map id="RTOS::clock_map" name="RTOS::clock_map">
<area href="class_r_t_o_s_1_1waitable.html" title="abstract thing that a task can wait for" alt="RTOS::waitable" shape="rect" coords="0,56,97,80"/>
<area href="class_r_t_o_s_1_1event.html" title="set of things that can happen, or a thing that has happened" alt="RTOS::event" shape="rect" coords="0,0,97,24"/>
</map>
 </div></div>

<p><a href="class_r_t_o_s_1_1clock-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acddd4420f67c5af6e130ca177526d148"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1clock.html#acddd4420f67c5af6e130ca177526d148">clock</a> (<a class="el" href="class_r_t_o_s_1_1task.html">task</a> *<a class="el" href="class_r_t_o_s_1_1event.html#a1402687edb26c1d5d26e54dbda21919d">t</a>, unsigned long long int <a class="el" href="class_r_t_o_s_1_1clock.html#aeef3e995e7334fc203f0062e532a5804">interval</a>, const char *name=&quot;&quot;)</td></tr>
<tr class="memdesc:acddd4420f67c5af6e130ca177526d148"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a clock for task t, specify interval and name  <a href="#acddd4420f67c5af6e130ca177526d148"></a><br/></td></tr>
<tr class="memitem:a90d7c2b274fff1b43a1de08e742c41c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1clock.html#a90d7c2b274fff1b43a1de08e742c41c3">clear</a> (void)</td></tr>
<tr class="memdesc:a90d7c2b274fff1b43a1de08e742c41c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">clear the waitable within the clock  <a href="#a90d7c2b274fff1b43a1de08e742c41c3"></a><br/></td></tr>
<tr class="memitem:aeef3e995e7334fc203f0062e532a5804"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeef3e995e7334fc203f0062e532a5804"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1clock.html#aeef3e995e7334fc203f0062e532a5804">interval</a> (void)</td></tr>
<tr class="memdesc:aeef3e995e7334fc203f0062e532a5804"><td class="mdescLeft">&#160;</td><td class="mdescRight">the interval of the timer <br/></td></tr>
<tr class="memitem:ad2d6da1595d84cbcc93cb73ed888a72a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2d6da1595d84cbcc93cb73ed888a72a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1clock.html#ad2d6da1595d84cbcc93cb73ed888a72a">print</a> (std::ostream &amp;s, bool header=true) const </td></tr>
<tr class="memdesc:ad2d6da1595d84cbcc93cb73ed888a72a"><td class="mdescLeft">&#160;</td><td class="mdescRight">print the clock (for debugging) <br/></td></tr>
<tr class="inherit_header pub_methods_class_r_t_o_s_1_1callback"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_r_t_o_s_1_1callback')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="class_r_t_o_s_1_1callback.html">RTOS::callback</a></td></tr>
<tr class="memitem:a5f39c98bd6b696c82c98e9b25cf3e883 inherit pub_methods_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f39c98bd6b696c82c98e9b25cf3e883"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>callback</b> (const char *name=&quot;&quot;)</td></tr>
<tr class="memitem:a487d4cddb983e9089daf85bfc94b7b4e inherit pub_methods_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a487d4cddb983e9089daf85bfc94b7b4e"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>time_up</b> (void)=0</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa5b30b5b619f01a5d94b779bf0e58610"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5b30b5b619f01a5d94b779bf0e58610"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>RTOS</b></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_r_t_o_s_1_1waitable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_r_t_o_s_1_1waitable')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="class_r_t_o_s_1_1waitable.html">RTOS::waitable</a></td></tr>
<tr class="memitem:a5a5bf9012a332a6451ee10728153908a inherit pro_methods_class_r_t_o_s_1_1waitable"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1waitable.html#a5a5bf9012a332a6451ee10728153908a">waitable</a> (<a class="el" href="class_r_t_o_s_1_1task.html">task</a> *<a class="el" href="class_r_t_o_s_1_1task.html">task</a>, const char *name)</td></tr>
<tr class="memdesc:a5a5bf9012a332a6451ee10728153908a inherit pro_methods_class_r_t_o_s_1_1waitable"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor, specify owner and name  <a href="#a5a5bf9012a332a6451ee10728153908a"></a><br/></td></tr>
<tr class="memitem:a3a72bdf94092471e82ba2d04cdc4a58e inherit pro_methods_class_r_t_o_s_1_1waitable"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a72bdf94092471e82ba2d04cdc4a58e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1waitable.html#a3a72bdf94092471e82ba2d04cdc4a58e">set</a> (void)</td></tr>
<tr class="memdesc:a3a72bdf94092471e82ba2d04cdc4a58e inherit pro_methods_class_r_t_o_s_1_1waitable"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the waitable <br/></td></tr>
<tr class="inherit_header pro_methods_class_r_t_o_s_1_1event"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_r_t_o_s_1_1event')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="class_r_t_o_s_1_1event.html">RTOS::event</a></td></tr>
<tr class="memitem:a00cf9d5d01e670e2b358c2a4c7578e7d inherit pro_methods_class_r_t_o_s_1_1event"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00cf9d5d01e670e2b358c2a4c7578e7d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_t_o_s_1_1event.html#a00cf9d5d01e670e2b358c2a4c7578e7d">event</a> (<a class="el" href="class_r_t_o_s_1_1task.html">task</a> *<a class="el" href="class_r_t_o_s_1_1event.html#a1402687edb26c1d5d26e54dbda21919d">t</a>, unsigned int <a class="el" href="class_r_t_o_s_1_1event.html#a74f6161d8c82d461ae3ba29f0e222b59">mask</a>)</td></tr>
<tr class="memdesc:a00cf9d5d01e670e2b358c2a4c7578e7d inherit pro_methods_class_r_t_o_s_1_1event"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor, used by concrete events <br/></td></tr>
<tr class="inherit_header pro_methods_class_r_t_o_s_1_1callback"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_r_t_o_s_1_1callback')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="class_r_t_o_s_1_1callback.html">RTOS::callback</a></td></tr>
<tr class="memitem:a7dfe2defb50c4ebd65da3b0699689959 inherit pro_methods_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dfe2defb50c4ebd65da3b0699689959"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>start</b> (long int time)</td></tr>
<tr class="memitem:a4daf77b0021874a215577adbbca4bde0 inherit pro_methods_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4daf77b0021874a215577adbbca4bde0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>restart</b> (unsigned long long int time)</td></tr>
<tr class="memitem:a9f18a723aa5c263f79398ec9cbe48a52 inherit pro_methods_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f18a723aa5c263f79398ec9cbe48a52"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>cancel</b> (void)</td></tr>
<tr class="memitem:a500774e4e05a3f5134b296c11d2ff920 inherit pro_methods_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a500774e4e05a3f5134b296c11d2ff920"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>tick</b> (int elapsed)</td></tr>
<tr class="inherit_header pro_attribs_class_r_t_o_s_1_1callback"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_r_t_o_s_1_1callback')"><img src="closed.png" alt="-"/>&nbsp;Protected Attributes inherited from <a class="el" href="class_r_t_o_s_1_1callback.html">RTOS::callback</a></td></tr>
<tr class="memitem:a09a4bfc3475f15c9a0ca34beeddc059b inherit pro_attribs_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09a4bfc3475f15c9a0ca34beeddc059b"></a>
long long int&#160;</td><td class="memItemRight" valign="bottom"><b>time_to_wait</b></td></tr>
<tr class="memitem:aad7c7a9e33012c64fe4de3dec9ef2fd1 inherit pro_attribs_class_r_t_o_s_1_1callback"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad7c7a9e33012c64fe4de3dec9ef2fd1"></a>
callback *&#160;</td><td class="memItemRight" valign="bottom"><b>nextTimer</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>free-running clock, ticks at a fixed frequency </p>
<pre class="fragment">  A clock is a waitable which is automatically sets itself 
  at fixed intervals. 
  The interval between these moments is specified when the 
  clock is created. 
  A clock is always running, even when the task to which it 
  belongs is suspended.

  The example below again shows the left-shifting and polarity 
  flipping Kitt display, but the actions are now caused by two 
  clocks. 
  Note that unlike the timers examples the clocks are never 
  explictly started.

  @code 
</pre><p> TBW  </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acddd4420f67c5af6e130ca177526d148"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">RTOS::clock::clock </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_r_t_o_s_1_1task.html">task</a> *&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long long int&#160;</td>
          <td class="paramname"><em>interval</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em> = <code>&quot;&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>create a clock for task t, specify interval and name </p>
<p>The name is used for debugging and statistics. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a90d7c2b274fff1b43a1de08e742c41c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void RTOS::clock::clear </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>clear the waitable within the clock </p>
<p>Note that this does not stop the clock. </p>

<p>Reimplemented from <a class="el" href="class_r_t_o_s_1_1waitable.html#a44ac71980592721bc03e076acc7e8c67">RTOS::waitable</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="p_r_t_o_s_8h_source.html">pRTOS.h</a></li>
<li>pRTOS.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 27 2012 11:07:15 for TagM by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
